vcVideoRecorder
The vcVideoRecorder is used to record a simulation to video file.
See in: Overview
Module: vcCore
Parent: -
Children -
Referenced by: vcApplication.VideoRecorder
Properties
Learn how to use properties here. The properties are also inherited from the parent class.
| Name | Type | Access | Description |
| IsRecording | Boolean | R | Gets whether a video recording is in progress or not. |
| OutputFilePath | String | R | Gets the path where the recording will be saved. |
Methods
Learn how to use methods here. The methods are also inherited from the parent class.
| Name | Return Type | Parameters | Description |
| start | None | Optional Keyword[outputFilePath = String], Optional Keyword[width = Integer], Optional Keyword[height = Integer], Optional Keyword[frameRate = Integer] | Starts the recording. For width and height, if one is specified then the other must be also specified. Example: Set frameRate but leave everything else as default. See morestart(frameRate=42) Parameters: Optional: outputFilePath (str): The path of the output file. Default value is {MyDocumentsFolder}\video.avi. Optional: width (int): The width of the recording. Default value is the screen width. Optional: height (int): The height of the recording. Default value is the screen height. Optional: frameRate (int): The frame rate of the recording. Default value is 24. Exceptions: ValueError: When missing width or height argument. ValueError: When the width value is invalid (e.g. negative). ValueError: When the height value is invalid (e.g. negative). ValueError: When the frame rate is invalid (e.g. negative). RuntimeError: When a PDF recording is already in progress. RuntimeError: When a video recording is already in progress. |
| stop | None | None | Stops the recording. Exceptions: RuntimeError: When no video recording is in progress. |